home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 45 / Amiga Format CD45 (1999-09)(Future Publishing)(GB)(Track 1 of 2)[!][issue 1999-11].iso / -serious- / programming / c / c_keywords / c_keywords.readme < prev    next >
Text File  |  1999-08-09  |  5KB  |  87 lines
  1. Short:    Online documentation for C keywords. vbcc autodocs harlock
  2. Author:   pfharlock@yahoo.com
  3. Uploader: pfharlock@yahoo.com
  4. Version:  1.0
  5. Type:     dev/c
  6.  
  7. This is online documentation for the C language keywords.  It is a
  8. standard commodore autodoc so any program written to interpret the
  9. commodore autodocs will also work on this file.
  10.  
  11. History
  12. I got the commodore autodocs a while back, and was very happy at the
  13. prospect of having online documentation for all the standard
  14. functions, much like those spoiled PC types have with visual C++ or
  15. Borland or something.  I quickly learned however, that, while all the
  16. functions in the amiga shared libraries are documented, the standard
  17. C functions and keywords common to all C implementations were not.
  18. The solution of course is what you see before you, Complete online
  19. documentation of all the standard C keywords in autodoc format.
  20.  
  21. Usage
  22. There are several programs on the aminet which will allow you to
  23. impliment autodocs in a variety of ways.  Of these, GoldEd is my
  24. favorite.  I use GoldEd to edit all of my source code.  It comes with
  25. a feature called references which will allow you to put the cursor on
  26. any word in your source code, go to the find menu and select the
  27. reference command, then GoldEd will pull up online help for that
  28. command.  For this feature of GoldEd to work properly you must
  29. configure it before hand.  You can specify that it should look
  30. through all your headers, and it will pull up the appropriate header
  31. and place your cursor at the start of the definition of the
  32. identifier you wanted help on.  Also if you tell it where the
  33. commodore autodocs are then you can have online help for all the
  34. standard amiga specific functions.
  35. To use this file with GoldEd, simply go to the config menu, and then
  36. to references.  A dialogue will appear, then you have to supply it
  37. the path to C_Keywords.doc.  After you have the path typed in you
  38. must also hit the create button near the bottom to create the file
  39. s:GoldEd.refs, which is where GoldEd stores the info on how to find
  40. the appropriate online doc for the keyword you have the cursor over. 
  41. That's it, if you have the commodore autodocs, then follow the same
  42. steps for them, in fact you could just copy this file into the same
  43. directory as the commodore autodocs.
  44.  
  45. There used to be an old registered version of GoldEd on aminet, which
  46. wasn't crippled, unfortunately I just found out that it has since
  47. been removed.  It was called ged314r.lha.  You can download the trial
  48. version of GoldEd 4.7.0, from aminet, but I believe that it will only
  49. save files if they are smaller than 100k or something.  In light of
  50. this, I suggest that you try one of the other proggy's on the aminet
  51. for interpreting autodocs and combine it with your own favorite text
  52. editor, Unless of course you already have GoldEd or can afford to buy
  53. it or something.
  54.  
  55. FUTURE
  56. In This file I have only documented the C Keywords.  I have yet to
  57. document the standard ANSI functions.  When I'm able to document them,
  58. I'll probably upload them as separate files from this one.  They will
  59. most likely be assorted by header file, (I.E. stdio.h, stdlib.h, etc),
  60. and probably be called C_stdio.lha and C_stdlib.lha etc etc.  Also
  61. in light of the fact that golded is no longer freely available I'm
  62. seriously considering writing a command that will parse autodocs and
  63. then zip your favorite text viewer or editor to the correct location
  64. of the command you wanted help on.  If I do decide to write such a
  65. command then it will most likely be after I've finished with the
  66. documentation.  Also if and when I do write it, I will include
  67. the source code, and it should be portable enough to compile on other
  68. platforms, (IE Unix, the next gen Amiga or even windows if you really
  69. wanted).
  70.  
  71. LEGAL STUFF AND MISCELLANEOUS RAMBLINGS
  72. If you need help getting this to work, my email is up there.  If you
  73. find gross mistakes, and are disgusted with my flagrant disregard
  74. for reality, then please let me know.  Any mistakes are unintentional
  75. and I won't guarantee that there are none.As such I accept no
  76. responsibility for loss of data, money, or life that may occur
  77. through the use of these online documents.  This project is Copyright
  78. to me.  This being said, anybody can do anything they like with it,
  79. except keep anybody else from doing whatever they want with it.
  80. I require that this readme file and the source to the autodocs
  81. accompany any other releases of this project, IE aminet CD's or
  82. whatever.  If you do release a modified version of these autodocs
  83. then you should indicate that you have modified them so as not to
  84. confuse people about who did the authoring.
  85.  
  86.       Tanks all, hope to get the rest done soon.
  87.